Add Learn frontmatter and asset paths#160
Merged
Merged
Conversation
Add commented GitHub Learn frontmatter to the course README files and include the course-level metadata files. Rename image asset folders to assets and update Markdown, instructions, and helper scripts to match the new paths. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the courseware repository to support GitHub Learn-style metadata and standardizes all image/demo references from images/ to assets/ across the root README, chapter READMEs, and the helper scripts used to generate/verify demo GIFs.
Changes:
- Added GitHub Learn metadata files (
index.yml,schema.json) and inserted commented frontmatter blocks into the root + chapter READMEs. - Migrated Markdown image links and HTML
<img>tags fromimages/toassets/, including cross-chapter references like../assets/practice.png. - Updated demo tooling scripts to discover
.tapeand*-demo.giffiles under chapterassets/folders, and added new.taperecordings underassets/.
Show a summary per file
| File | Description |
|---|---|
| schema.json | Adds a JSON schema for course/page metadata. |
| index.yml | Adds course-level metadata (title/description/icon). |
| README.md | Adds commented Learn frontmatter and updates root image paths to assets/. |
| .github/copilot-instructions.md | Updates repo contribution conventions and maintenance matrix to reference assets/. |
| .gitignore | Adds migration.md to ignored files. |
| .github/scripts/verify-gifs.js | Updates GIF discovery to scan chapter assets/ directories. |
| .github/scripts/preview-gifs.js | Updates GIF discovery to scan chapter assets/ directories. |
| .github/scripts/generate-demos.js | Updates .tape discovery doc + scanning to use chapter assets/ directories. |
| .github/scripts/create-tapes.js | Writes generated .tape files into chapter assets/ directories. |
| .github/scripts/generate-chapter-headers.py | Writes headers/background paths using repo/chapter assets/ directories. |
| assets/copilot-banner.png | Moves/updates course banner under assets/. |
| assets/learning-path.png | Moves/updates learning-path image under assets/. |
| assets/practice.png | Moves/updates shared “practice” image under assets/. |
| assets/quick-reference-header.png | Adds/migrates an image asset to assets/. |
| assets/github-skills-logo.png | Adds/migrates the GitHub Skills logo to assets/. |
| 00-quick-start/README.md | Adds commented frontmatter and updates chapter image paths to assets/. |
| 00-quick-start/assets/chapter-header.png | Chapter header now located under chapter assets/. |
| 00-quick-start/assets/hello-demo.tape | Adds VHS tape source under chapter assets/. |
| 01-setup-and-first-steps/README.md | Adds commented frontmatter and updates chapter image paths to assets/. |
| 01-setup-and-first-steps/assets/chapter-header.png | Chapter header now located under chapter assets/. |
| 01-setup-and-first-steps/assets/code-review-demo.tape | Adds VHS tape source under chapter assets/. |
| 01-setup-and-first-steps/assets/explain-code-demo.tape | Adds VHS tape source under chapter assets/. |
| 01-setup-and-first-steps/assets/generate-code-demo.tape | Adds VHS tape source under chapter assets/. |
| 02-context-conversations/README.md | Adds commented frontmatter and updates chapter image paths to assets/ (incl. @assets/... examples). |
| 02-context-conversations/assets/file-context-demo.tape | Adds VHS tape source under chapter assets/. |
| 02-context-conversations/assets/multi-file-demo.tape | Adds VHS tape source under chapter assets/. |
| 02-context-conversations/assets/multi-turn-demo.tape | Adds VHS tape source under chapter assets/. |
| 03-development-workflows/README.md | Adds commented frontmatter and updates chapter image paths to assets/ (incl. Skills logo reference). |
| 03-development-workflows/assets/code-review-demo.tape | Adds VHS tape source under chapter assets/. |
| 03-development-workflows/assets/fix-bug-demo.tape | Adds VHS tape source under chapter assets/. |
| 03-development-workflows/assets/refactor-demo.tape | Adds VHS tape source under chapter assets/. |
| 03-development-workflows/assets/test-gen-demo.tape | Adds VHS tape source under chapter assets/. |
| 03-development-workflows/assets/git-integration-demo.tape | Adds VHS tape source under chapter assets/. |
| 03-development-workflows/assets/request.json | Adds an asset generation prompt/config under chapter assets/. |
| 04-agents-custom-instructions/README.md | Adds commented frontmatter and updates chapter image paths to assets/. |
| 04-agents-custom-instructions/assets/python-reviewer-demo.tape | Adds VHS tape source under chapter assets/. |
| 05-skills/README.md | Adds commented frontmatter and updates chapter image paths to assets/. |
| 05-skills/assets/skill-trigger-demo.tape | Adds VHS tape source under chapter assets/. |
| 05-skills/assets/list-skills-demo.tape | Adds VHS tape source under chapter assets/. |
| 06-mcp-servers/README.md | Adds commented frontmatter and updates chapter image paths to assets/. |
| 06-mcp-servers/assets/mcp-status-demo.tape | Adds VHS tape source under chapter assets/. |
| 06-mcp-servers/assets/mcp-workflow-demo.tape | Adds VHS tape source under chapter assets/. |
| 07-putting-it-together/README.md | Adds commented frontmatter and updates chapter image paths to assets/. |
Copilot's findings
- Files reviewed: 17/114 changed files
- Comments generated: 0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add GitHub Learn frontmatter to the root and chapter README files